public class GxColumnGroup extends GxDefaultColumnGroup implements GxColumnsManagerInterface
The class holds the grid column group. With this object you can group several columns and several column groups together to create deep nested structure.
Modifier and Type | Field and Description |
---|---|
BBjString | GroupId! The unique ID to give the column. |
Constructor and Description |
---|
GxColumnGroup(BBjString id!) Construct new GxColumnGroup |
GxColumnGroup(BBjString id! , BBjString label!) Construct new GxColumnGroup |
Modifier and Type | Method and Description |
---|---|
GxColumn | addColumn(GxColumn definition!) Add new column definition
|
GxColumn | addColumn(BBjString field!, BBjNumber type!) Add new column definition
|
GxColumn | addColumn(BBjString field!, BBjString label!) Add new column definition
|
GxColumn | addColumn(BBjString field!, BBjString label!, BBjNumber type!) Add new column definition
|
GxColumn | addColumn(BBjString field!) Add new column definition
|
GxColumnGroup | addColumnGroup(GxColumnGroup definition!) Add column group
|
GxColumnGroup | addColumnGroup(BBjString id!) Add column group
|
GxColumnGroup | addColumnGroup(BBjString id!, BBjString label!) Add column group
|
JsonObject | getAsJsonObject() Convert the definition to Json Object |
GxColumn | getColumn(BBjString field!) Get the column definition instance
|
GxColumnGroup | getColumnGroup(BBjString id!) Get the column group definition instance
|
BBjNumber | hasColumn(BBjString field!) Check if the column definition exists
|
BBjNumber | hasColumnGroup(BBjString id!) Check if the column group definition exists
|
GxColumn | removeColumn(BBjString field!) Remove a column definition
|
GxColumnGroup | removeColumnGroup(BBjString id!) Remove a column group definition
|
void | resetAllColumns() Clear all columns and column groups
|
void | setGroupId() Throw an error when called because the group id becomes immutable after the column group's definition creation |
public BBjString GroupId!
The unique ID to give the column.
public GxColumnGroup(BBjString id!)
Construct new GxColumnGroup
BBjString
id! The group idpublic GxColumn addColumn(GxColumn definition!)
Add new column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumn addColumn(BBjString field!, BBjNumber type!)
Add new column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumn addColumn(BBjString field!, BBjString label!)
Add new column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumn addColumn(BBjString field!, BBjString label!, BBjNumber type!)
Add new column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumn addColumn(BBjString field!)
Add new column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumnGroup addColumnGroup(GxColumnGroup definition!)
Add column group
#Configuration
#ColumnsRenderer
BBjString
id! The group idBBjString
label! The group labelpublic GxColumnGroup addColumnGroup(BBjString id!)
Add column group
#Configuration
#ColumnsRenderer
BBjString
id! The group idBBjString
label! The group labelpublic GxColumnGroup addColumnGroup(BBjString id!, BBjString label!)
Add column group
#Configuration
#ColumnsRenderer
BBjString
id! The group idBBjString
label! The group labelpublic JsonObject getAsJsonObject()
Convert the definition to Json Object
public GxColumn getColumn(BBjString field!)
Get the column definition instance
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumnGroup getColumnGroup(BBjString id!)
Get the column group definition instance
#Configuration
#ColumnsRenderer
BBjString
id! The column group definition idpublic BBjNumber hasColumn(BBjString field!)
Check if the column definition exists
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic BBjNumber hasColumnGroup(BBjString id!)
Check if the column group definition exists
#Configuration
#ColumnsRenderer
BBjString
id! The column group definition idpublic GxColumn removeColumn(BBjString field!)
Remove a column definition
#Configuration
#ColumnsRenderer
BBjString
field! The column's definition fieldpublic GxColumnGroup removeColumnGroup(BBjString id!)
Remove a column group definition
#Configuration
#ColumnsRenderer
BBjString
id! The column group definition idpublic void resetAllColumns()
Clear all columns and column groups
#Configuration
#ColumnsRenderer
public void setGroupId()
Throw an error when called because the group id becomes immutable after the column group's definition creation